home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / boxpkr42.zip / BOXPOKER.DOC < prev    next >
Text File  |  1992-06-07  |  22KB  |  469 lines
  1.  
  2.                                BOX POKER
  3.    
  4.                                   v4.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    BOX POKER is a fast-paced board game in which you remove number
  21.    combinations from the board based upon the roll of the dice.
  22.  
  23.  
  24.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  25.          created in the directory you run the door from.
  26.  
  27.  
  28.  
  29.                               INSTALLATION
  30.                               ____________
  31.  
  32.  
  33.    Installation is fairly easy and straight-forward. The following steps and
  34.    examples should have you up and running in a very short period of time.
  35.    It is assumed that you are familiar with setting up DOORS on your system.
  36.    To this end, only examples of the configuration file and Door batch file
  37.    are described.
  38.  
  39.       1) Create a directory to hold all BOX POKER files
  40.  
  41.       2) Unzip BOXPKRxx.ZIP into the the above directory
  42.  
  43.          NOTE: BRUN45.EXE is not included but is required !!!
  44.  
  45.       3) Create a configuration file, with a name of your choice, or
  46.          modify the supplied BOXPOKER.CFG file. A description follows:
  47.  
  48.             **                       Location of system file (See Below)
  49.             SUNRISE-80 BBS           Your BBS Name
  50.             Al                       Sysop's First Name
  51.  
  52.             Lawrence                 Sysop's Last Name
  53.  
  54. |-----------------------------------------------------------------------------|
  55. | READ!     1                        CommPort  \ These 2 lines are required   |
  56. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  57. |-----------------------------------------------------------------------------|
  58.  
  59.             00000000                 Registration Number
  60.             
  61.     !    #  2                        Keyboard timeout value in Minutes
  62.  
  63.          #  1                        Number of games allowed per day
  64.  
  65.          #  0                        Max # of days a caller can make up, during
  66.                                      calls in one day. 0=Disable Make-up Option
  67.                                      Maximum value = 27, Minimum value = 1
  68.  
  69.          #  NONE                     Drive:\Path\Filename to contain the
  70.                                      Top Score Bulletin or enter NONE
  71.                                      for NO Bulletin creation.
  72.  
  73.          #  NONE                     Drive:\Path\Filename to contain the
  74.                                      Top Score Bulletin (Color) or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Hall of Fame Bulletin or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.         #   NONE                     Drive:\Path\Filename to contain the
  82.                                      Hall of Fame Bulletin (Color) or enter NONE
  83.                                      for NO Bulletin creation.
  84.  
  85.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  86.                                      2 = Display ADOPT-A-DOOR message
  87.  
  88.     !   #   0                        Time Allowed in Door
  89.                                      (Sysop - Time Remaining - REG. VERSION)
  90.  
  91.         #   N                        Automatic game reset at end of month:
  92.                                        Y = Yes enable autoreset
  93.                                        N = Keep accumulating scores
  94.  
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.  
  106.     @   #   XXXX/YYYY                 Blackout Range  From/To
  107.     @   #   XXXX/YYYY                 Blackout Range  From/To
  108.     @   #   XXXX/YYYY                 Blackout Range  From/To
  109.     @   #   XXXX/YYYY                 Blackout Range  From/To
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.         #   1                         Pt value for ONE PAIR       (1-9)
  112.         #   3                         Pt value for TWO PAIR       (1-9)
  113.         #   6                         Pt value for 3 of a KIND    (1-9)
  114.         #   12                        Pt value for STRAIGHT       (1-99)
  115.         #   5                         Pt value for FLUSH          (1-9)
  116.         #   10                        Pt value for FULL HOUSE     (1-99)
  117.         #   16                        Pt value for 4 of a KIND    (1-99)
  118.         #   30                        Pt vlaue for STRAIGHT FLUSH (1-99)
  119.  
  120.           ** = Replace with ONE of the following:
  121.  
  122. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  123. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  124. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  125.                                    (Note:DOOR.SYS must be in SAME directory)
  126. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  127. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  128. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  129. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  130. C:\BBS\GTUSER.BBS               <- For GT Power 
  131.                                    * if using this option you must put the
  132.                                      ComPort # on line 5 and the Node # on
  133.                                      line 6 of the configuration file
  134.  
  135.  
  136.               
  137.  
  138.            # = Requires registration to change to a different value
  139.            ! = See "Plays Per Day" Below
  140.            @ = See "Blackout Periods" Below
  141.  
  142.                NOTE: There are NO Blank Lines in the Config File!!
  143.  
  144.  
  145.       4) Create a batch file or modify the HIROLL file supplied. A
  146.          description of this file follows:
  147.  
  148.             ECHO off
  149.             cd\BBS\DOORS\BOXPOKER     Location of BOXPOKER files
  150.             BOXPOKER BOXPOKER.CFG     EXE filename and CFG filename (Name
  151.                                       used in creating file in #3 above)
  152.             CD\BBS
  153.             BOARD
  154.  
  155.  
  156.        5) When running in more than one node, be sure to supply a
  157.           different configuration name for each node (your choice of name).
  158.  
  159.  
  160.   
  161.          
  162.                MAKE-UP DAYS (Registered version only)
  163.                --------------------------------------
  164.  
  165. The Make-Up-Day feature allows the caller to make up any plays he/she missed 
  166. during the current month and prior to the current call. You control whether 
  167. to allow this option, as well as the number of days the caller can make up, on
  168. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  169. configuration file, turns the option OFF, any other value (up to a max of 27)
  170. turns the option ON and dictates the number of days the caller can make up.
  171.  
  172.  
  173. NOTE:      The number of games per day is calculated as follows...
  174.  
  175.            Games Allowed per day x Number of makeup days.
  176.  
  177. Example:   Games Allowed per day = 2
  178.            Max # of makeup days  = 4
  179.  
  180. If a caller logs in on 5/8/92 and this is their first call of the month, they
  181. would have a potential of 16 games to makeup and bring them current 
  182. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  183. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 
  184. (games allowed * max # of makeup days).
  185.  
  186.  
  187.  
  188.              HALL OF FAME BULLETINS (Registered version only)
  189.              ------------------------------------------------
  190.  
  191. The program will automatically reset the game when the first caller of the
  192. month plays the game. The score file will be cleared and a set of Hall of Fame
  193. bulletin files will be created. The files will be called SUNHOF.ASC and 
  194. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same 
  195. directory as the BETSY.EXE file. You are responsible for COPYING the files to 
  196. your bulletin area and renaming to a filename of your choice.
  197.  
  198. WARNING: The HOF files are cumulative files. That means they are read in each 
  199.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  200.          the record of prior months winners!!!!
  201.  
  202.  
  203.  
  204.  
  205.  
  206.                           BLACKOUT PERIODS
  207.                           ________________
  208.  
  209.       Use the Blackout ranges option to define up to 5 time periods during
  210.       which you DO NOT want the Door to be played. If a caller tries to access 
  211.       the Door during the Blackout period, they will be shown a message that
  212.       contains ALL the Blackout periods you have defined, and to try the Door
  213.       at a later time.
  214.  
  215.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  216.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  217.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  218.  
  219.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  220.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  221.                    a Blackout range.
  222.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  223.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  224.  
  225.  
  226.                           PLAYS Per DAY/DOOR Time
  227.                           _______________________
  228.  
  229.       Plays Per Day and Door Time can be controlled several ways:
  230.  
  231.       (1) You can use the Games Per Day, singular option, in the config
  232.           file above. This option, will affect ALL callers whose Security
  233.           Level is NOT defined in any of the 10 optional Security Level/
  234.           Plays Per Day entries in the config file.
  235.  
  236.       (2) You can use the Door Time, singular option, in the config file
  237.           above. This option, will affect ALL callers whose Security
  238.           Level is NOT defined in any of the 10 optional Security Level/
  239.           Plays Per Day/Door Time entries in the config file.
  240.  
  241.       (3) You can restrict the number of games a specific Security Level
  242.           will be allowed to play per day or REWARD specific Levels with 
  243.           more Plays Per Day. 
  244.  
  245.           Likewise, you can restrict the Play time for a specific Security
  246.           Level or REWARD specific Levels with more Door Time.
  247.  
  248.           These options are handled by the use of the 10 config 
  249.           entries (000=00/00). 
  250.           
  251.           The format of each entry is as follows:
  252.  
  253.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  254.                      where =  is a constant and MUST be included
  255.                      where YY is the # of games per day (must be 2 digits)
  256.                      where / is a constant and MUST be included
  257.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  258.           
  259.           If the callers Security Level is NOT defined, his/her Plays Per
  260.           Day and Door Time will be controlled by the values in items
  261.           (1) and (2), above, respectively..
  262.  
  263.           You may define up to 10 Security Levels. All unused entries must
  264.           be defined as   000=00/00
  265.         --------------------------------------------------------------------
  266.           Example: Suppose you had 3 Security Levels defined on your BBS as
  267.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  268.           wanted to set Plays Per Day as :     Subscriber=5
  269.                                            Visiting Sysop=2
  270.                                                   CoSysop=3
  271.                                                    Friend=10 
  272.           
  273.           and Door Time as follows:     Subscriber=30 minutes
  274.                                     Visiting Sysop=20 minutes
  275.                                            CoSysop=10 minutes 
  276.                                             Friend=remaining call time
  277.                                
  278.  
  279.           You would set the Individual "Games per Day" config entry to 1 and 
  280.           the individual "Door Time" to 5 minutes (these would be the 
  281.           default number of games and default Time for all Security Levels
  282.           other than 20,30 or 40... make them any number you want). Next you
  283.           would replace 4 of the Security Level entries as :  020=05/30                                               
  284.                                                               030=02/20
  285.                                                               040=03/10
  286.                                                               090=10/0
  287.  
  288.  
  289.                         NON-STANDARD COM SUPPORT
  290.                         ________________________
  291.  
  292.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  293.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  294.       number after the configuration filename. Let's assume your Door is
  295.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  296.       passed to your Door would be:
  297.  
  298.                             FOOBAR FOOBAR.CFG /5
  299.  
  300.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  301.       normally used with COM1. No /x parameter is needed for the standard
  302.       IRQ's.
  303.  
  304.       As an alternative, you may use an environmental variable on the command
  305.       line. To use the variable (following the example above), place a 
  306.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  307.       different IRQ number for each node). The command line would now look 
  308.       like this: 
  309.  
  310.                           FOOBAR FOOBAR.CFG /%IRQ%
  311.       
  312.       This, in combination with the use of the environmental variables 
  313.       described in the MULTI-NODE SETUP section will allow you to use one 
  314.       batch file and one config file to run this door on all nodes.
  315.  
  316.  
  317.  
  318.  
  319.                            MULTI-NODE SETUP
  320.                            ________________
  321.  
  322.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  323.       ability to access a configuration file which will have its own system 
  324.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  325.       line. There are 2 ways to accomplish this:
  326.  
  327.       (1) Create a separate configuration file for each node. The only 
  328.           difference between each file would be the location of the system 
  329.           file for that particular node. For example, on my system there are 2
  330.           nodes and the first line of the config files would look like this:
  331.  
  332.                         NODE1:  H:\PCB1\DOOR.SYS
  333.                         NODE2:  H:\PCB2\DOOR.SYS
  334.  
  335.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  336.  
  337.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  338.           the following PCBoard environmental variables:
  339.  
  340.                  PCBDIR    (Directory containing the System file)
  341.                  PCBDRIVE  (Drive containing the System file)
  342.  
  343.           Thus, the first line of the SINGLE configuration file, for this Door
  344.           would look like this:
  345.  
  346.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  347.  
  348.       NOTE: This option, as described, assumes that you are running PCBoard 
  349.             14.5a software. The environmental variables are automatically 
  350.             created by the software for each node.
  351.  
  352.             HOWEVER, if you are running other BBS software you should be able
  353.             to set the variables EXACTLY as described below, for EACH node 
  354.             (more than likely in each batch file you use to bring up EACH node):
  355.  
  356.                             PCBDRIVE=C:
  357.                             ^^^^^^^^^
  358.                             PCBDIR=\NODE2
  359.                             ^^^^^^^^
  360.             
  361.             Info with a carat (^) under it, MUST be typed as is. The rest 
  362.             depends on your naming conventions. 
  363.  
  364.             This, in combination with the use of the optional environmental
  365.             variable described in the NON-STANDARD COM SUPPORT section, will
  366.             allow you to use one batch file and one config file to run this 
  367.             door on all nodes.
  368.  
  369.  
  370.  
  371.                                ADOPT-A-DOOR
  372.                                ____________
  373.  
  374.     Having been a Sysop for a number of years, I have had my share of problems
  375.     and frustrations getting financial support for my board's upkeep. A fellow
  376.     Sysop left a message on my board, not long ago, about a concept that was
  377.     being used by several boards around the country.
  378.  
  379.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  380.     would be the same as sending in a donation, only this way it is earmarked
  381.     for registering a particular door. In a way, the user feels he/she is
  382.     "getting something in return". As a Door author I have decided to build
  383.     this concept into each of my Door programs. The concept replaces the
  384.     usual message "tell the Sysop to register this Door" we find in most
  385.     doors.
  386.  
  387.     If the Door is unregisterd then a message appears on the opening screen
  388.     to that effect. After finishing or suspending a game, a message screen
  389.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  390.     caller to contact the Sysop to find out if there is any further details
  391.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  392.     time, etc to callers that ADOPT-A-DOOR.
  393.  
  394.     If the Door has been registered, either by the Sysop or other callers,
  395.     the names of those contributors will be displayed in the closing screen.
  396.  
  397.     NOTE: If you want to display the names of the callers that contributed
  398.           to registering the Door, you must create an ASCII file called
  399.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  400.           the name(s) of the contributors (one on each line, maximum of 5
  401.           entries, each a maximum of 30 characters long). This file must be
  402.           saved, in ASCII format, and placed in the Door directory.
  403.  
  404.  
  405.  
  406.                               LEGALITIES
  407.                               __________
  408.  
  409.  
  410.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  411.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  412.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  413.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  414.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  415.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  416.       OR BREACH OF ANY WARRANTY.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.                              DISTRIBUTION
  423.                              ____________
  424.  
  425.    You may make this file available for downloading from your BBS or you may
  426.    upload it to any BBS of your choice, provided that you do not make any
  427.    changes to the contents of the archive (ZIP file). The archive and its
  428.    individual contents may not be used by any service that charges any money
  429.    whatsoever, without the written permission of the author.
  430.  
  431.  
  432.  
  433.  
  434.  
  435.                              REGISTRATION
  436.                              ____________
  437.  
  438.    Registration and the subsequent insertion of the registration number into
  439.    your configuation file, allows for the display of your BBS name on the
  440.    opening and closing screen as well as the reduction of a delay built into
  441.    the opening screen display along with your ability to change certain
  442.    values in the configuration file.
  443.  
  444.    To register your copy of BOXPOKER, please fill out the registration form
  445.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  446.    the name and address on the form or send a self-addressed stamped
  447.    envelope and your registration number will be forwarded by return mail.
  448.  
  449.    Be sure to use the proper upper/lower case when filling in your name and
  450.    BBS name, as they MUST match the way you entered them in the configuration
  451.    file.             ^^^^
  452.  
  453.    Based upon information supplied on the registration form, I will pre-
  454.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  455.    up your registration number.
  456.  
  457.  
  458.  
  459.                                  MISC
  460.                                  ____
  461.  
  462.    The latest version of BOXPOKER and other fine SUNRISE DOOR programs
  463.    are always available for download from SUNRISE-80 BBS.
  464.  
  465.    Remember, should you have any problems, questions or suggestions, be sure
  466.    to drop me a message on my BBS or you can reach me thru PCRELAY/RIME on
  467.    the BBS DOOR, SYSOPS or PCBHints conferences or routed to ->SUNRISE or
  468.    FIDOnet  1:133/410 or SmartNet (Sysops).
  469.